<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>log_sink</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../index.html" title="Boost.Test">
<link rel="up" href="../rt_param_reference.html" title="Runtime parameters reference">
<link rel="prev" href="log_level.html" title="log_level">
<link rel="next" href="logger.html" title="logger">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="log_level.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../rt_param_reference.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="logger.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_test.utf_reference.rt_param_reference.log_sink"></a><a class="link" href="log_sink.html" title="log_sink"><code class="computeroutput"><span class="identifier">log_sink</span></code></a>
</h4></div></div></div>
<p>
          Parameter <span class="emphasis"><em>log_sink</em></span> allows to set the log sink - location
          where framework writes the testing log to, thus it allows to easily redirect
          the testing log to file or standard streams. By default testing log is
          directed to the standard output stream.
        </p>
<h5>
<a name="boost_test.utf_reference.rt_param_reference.log_sink.h0"></a>
          <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.log_sink.acceptable_values"></a></span><a class="link" href="log_sink.html#boost_test.utf_reference.rt_param_reference.log_sink.acceptable_values">Acceptable
          values</a>
        </h5>
<p>
          Case sensitive <a class="link" href="../rt_param_reference.html#regular_param_value">string</a>:
        </p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Value
                  </p>
                </th>
<th>
                  <p>
                    Meaning
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    <span class="bold"><strong><code class="computeroutput"><span class="identifier">stdout</span></code></strong></span>
                    (default for HRF and XML)
                  </p>
                </td>
<td>
                  <p>
                    Testing log is redirected into standard output stream
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    stderr
                  </p>
                </td>
<td>
                  <p>
                    Testing log is redirected into standard error stream
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    File name (default for JUNIT)
                  </p>
                </td>
<td>
                  <p>
                    Testing log is redirected into this file
                  </p>
                </td>
</tr>
</tbody>
</table></div>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>
            For JUnit and if not specified, the log file is generated after the name
            of the <a class="link" href="../../tests_organization/test_tree/master_test_suite.html" title="Master test suite">master
            test suite</a>.
          </p></td></tr>
</table></div>
<h5>
<a name="boost_test.utf_reference.rt_param_reference.log_sink.h1"></a>
          <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.log_sink.command_line_syntax"></a></span><a class="link" href="log_sink.html#boost_test.utf_reference.rt_param_reference.log_sink.command_line_syntax">Command
          line syntax</a>
        </h5>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
              <code class="computeroutput"><span class="special">--</span><span class="identifier">log_sink</span><span class="special">=&lt;</span><span class="identifier">stream</span>
              <span class="keyword">or</span> <span class="identifier">file</span>
              <span class="identifier">name</span><span class="special">&gt;</span></code>
            </li>
<li class="listitem">
              <code class="computeroutput"><span class="special">-</span><span class="identifier">k</span>
              <span class="special">&lt;</span><span class="identifier">stream</span>
              <span class="keyword">or</span> <span class="identifier">file</span>
              <span class="identifier">name</span><span class="special">&gt;</span></code>
            </li>
</ul></div>
<h5>
<a name="boost_test.utf_reference.rt_param_reference.log_sink.h2"></a>
          <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.log_sink.environment_variable"></a></span><a class="link" href="log_sink.html#boost_test.utf_reference.rt_param_reference.log_sink.environment_variable">Environment
          variable</a>
        </h5>
<pre class="programlisting"><span class="identifier">BOOST_TEST_LOG_SINK</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2001-2020 Boost.Test contributors<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="log_level.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../rt_param_reference.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="logger.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
